home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / PROGTOOL / WC40REC.ZIP;1 / WCDOORS.DOC < prev    next >
Encoding:
Text File  |  1994-06-02  |  13.6 KB  |  286 lines
  1.  
  2. Door Structures
  3. ---------------
  4. For the release of Wildcat! 4 we have redone the files that Wildcat
  5. creates when it running an external program, the only file that remains
  6. the same is DOOR.SYS which provides compatablility some older style
  7. doors as well as doors used by RBBS/GAP & PCBOARD.
  8.  
  9. DOOR.SYS is meant as a universal standard for sharing door programs,
  10. because of this it does not contain all the information that is required
  11. for a full blown Wildcat! 4 application. We only create the file, we do
  12. not check it for changes when the door returns, instead we have three
  13. other drop files that we use to handle this type of information, they
  14. are as follows:
  15.  
  16. SYSINFO.DAT
  17. -----------
  18.  
  19. This file contains all the current Wildcat! 4 system information, on
  20. return from the door Wildcat checks this file and makes the appropriate
  21. changes to the current running system. This is a standard text file.
  22.  
  23. Here is the layout for SYSINFO.DAT:
  24.  
  25. MSI HQ BBS       {Line  1 - The current BBS Name                        }
  26. 19200            {Line  2 - Current Baud Rate (300-15200 and Local)     }
  27. 8                {Line  3 - Databits                                    }
  28. Y                {Line  4 - 'N' = No color, 'Y' = Ansi, 'R' = Rip       }
  29. Y                {Line  5 - MNP connection                              }
  30. 52               {Line  6 - Time remaining online                       }
  31. 30               {Line  7 - Banked time                                 }
  32. 14:22 02/22/94   {Line  8 - Time and date of call                       }
  33. 14:28 02/22/94   {Line  9 - Time and date entered door                  }
  34. N                {Line 10 - Started with command line option            }
  35. 20               {Line 11 - Current conference number                   }
  36. 1                {Line 12 - Active menu number                          }
  37. 3                {Line 13 - Current door number                         }
  38. N                {Line 14 - Did the caller hang-up in door              }
  39. N                {Line 15 - Reserved for future use                     }
  40. Y P Z D G        {Line 16 - Current commands on command stack           }
  41. SERIAL           {Line 17 - Interface type (SERIAL, DIGI, FOSSIL, LOCAL }
  42. ENGLISH          {Line 18 - Current language                            }
  43.  
  44. A few notes about line 15, when Wildcat creates the SYSINFO.DAT file it
  45. takes the contents of the current command stack and writes them to line
  46. 15, all of the doors that MSI writes takes advantage of this and will
  47. continue to process the commands, when the door is finished it will write
  48. the remainder of the stack to line 15 where Wildcat will re-parse the line
  49. and continue to process it. This provides a seamless interface for callers
  50. when they are running external programs, Wildcat will accept spaces, commas
  51. and semi-colons as delimeters.
  52.  
  53.  
  54. USERREC.BIN
  55. ------------
  56.  
  57. This file is a list of all the currently marked files at the time the door
  58. was started, after Wildcat has created this list it clears the current
  59. users list in memory and upon returning from the door reads the list back
  60. into the marked list. This allows doors the ability to add and delete files
  61. to the current mark list, you are allowed a maximum of 99 files.
  62. The list contains two types of files, Standard which are files found in the
  63. current file database and Direct which are files that can be located on
  64. any logical device.
  65.  
  66. Here is the layout for FILEINFO.DAT:
  67.  
  68. 10                   {Line 1   - The amount of marked files in this list  }
  69. 2                    {1 File 1 - The file area this file came from        }
  70. DRWY221.ZIP          {2 File 1 - The actual file name of this file        }
  71. STANDARD             {3 File 1 - The type of this file (STANDARD, DIRECT) }
  72. N                    {4 File 1 - Is this file on CD ROM                   }
  73. N                    {5 File 1 - Scanned (used by the Thumbnailer)        }
  74. 10                   {6 File 1 - Used by the ThumbNailer                  }
  75. C:\XFS\DRWY221.ZIP   {7 File 1 - Path and filenane of current file        }
  76. 0                    {1 File 2 - The file area this file came from        }
  77. TESTFILE.ZIP         {2 File 2 - The actual file name of this file        }
  78. DIRECT               {3 File 2 - The type of this file (STANDARD, DIRECT) }
  79. N                    {4 File 2 - Is this file on CD ROM                   }
  80. N                    {5 File 2 - Scanned (used by the Thumbnailer)        }
  81. 0                    {6 File 2 - Used by the ThumbNailer                  }
  82. C:\XFS\TESTFILE.ZIP  {7 File 2 - Path and filenane of current file        }
  83.  
  84. When you specify a direct file type, the only options that have any meaning
  85. are Line 2, Line 3 and Line 7. Wildcat will use these lines to present and
  86. send the file to the user.
  87.  
  88.  
  89. USERREC.DAT
  90. -----------
  91.  
  92. This file is an actual copy of the user's records that Wildcat keeps in
  93. memory while the user is on the BBS, this is not a text file, it is written
  94. out as straight binary and must be loaded into a TUserRec structure in order
  95. to be used by your program. This means you can change any of the users
  96. information in their current record without ever touching the databases, when
  97. Wildcat returns from a door it checks to make sure that the USERREC.DAT is
  98. the correct size before it will load it, if it has been corrupted Wildcat
  99. will make a note of it in the error.log and continue using the record in
  100. memory. Make sure you know what you are doing BEFORE you start playing with
  101. this file, you can cause a user all types of trouble if you accidently set
  102. some of the fields incorrectly and Wildcat reads the file back in.
  103.  
  104.  
  105. PROFILE.DAT
  106. -----------
  107.  
  108. This file is created at the time the user logs onto the system and anytime
  109. you upgrade a users access, it contains the users current security profile
  110. (TSECREC) and all of their seconday profile accesses combined into one file.
  111. The file is used for checking access to Doors, Menu Items, Protocols, Nodes,
  112. Conferences and File areas, the file is used by Wildcat and wcMAIL and cannot
  113. be modified, if you change the file in any way, there is no guarantee as to
  114. how Wildcat will react.
  115.  
  116. Here is the format of the file:
  117.  
  118.  
  119. +----------------------------+
  120. |                            |
  121. | Users Current TSecRec File |
  122. |                            |
  123. +----------------------------+
  124. |                            |
  125. | Conference access bits     |
  126. |                            |
  127. | 3 For each conference      |
  128. |                            |
  129. +----------------------------+
  130. |                            |
  131. | File access bits           |
  132. |                            |
  133. | 3 For each file area       |
  134. |                            |
  135. +----------------------------+
  136.  
  137.  
  138. This layout is identical to the one used in the SECLEVEL.DAT file, except this
  139. is one single record, for more information on how to read the bits and their
  140. exact meaning, see the documentation on the SECLEVEL.DAT file.
  141.  
  142.  
  143.  
  144. DOOR.SYS
  145. --------
  146.  
  147.  
  148.          03/14/88 - Submitted by the "Limited Release Software Group"
  149.  
  150. Updated: 03/21/88
  151. Updated: 10/22/88  KG
  152. Updated: 07/07/90  KG, to add additional info for Raymond Clements
  153. Updated: 07/14/91  Note to developers added by Jim Harrer/Mustang Software.
  154.  
  155. =============================================================================
  156.  
  157. Sample DOOR.SYS file to be used as a STANDARD for ALL Bulletin Board Systems.
  158.  
  159. =============================================================================
  160.  
  161.   This file format has been laid out and will be presented to ALL BBS authors
  162. in an attempt to establish a national standard for door program applications.
  163.  
  164. BBS AUTHORS: I urge you to consider this STANDARD with respect for your 3rd
  165.              party support authors. Come on guys, make life EASY for us.
  166.                                                                 (BIG GRIN)
  167.  
  168. =============================================================================
  169.  
  170.   I have tried to include EVERYTHING a 3rd party DOOR author would need to
  171. provide the SYSOPS with the look and feel they want from an online program
  172. while at the same time keeping things plain and simple to ease the problems
  173. of interfacing programs with a system.
  174.  
  175. This type of format is intended to be a "read-only" type of file
  176. (although it could be written again) because most BBS's have some sort
  177. of other file they use for re-entering the system with (PCBoard uses
  178. PCBOARD.SYS) which is harder to read in, and changes frequently.
  179. This file format, once established, wouldn't need to be changed EVERYTIME
  180. a new version of the BBS software gets released and this would also
  181. ease the demand for more info being made available in the BBS Re-Entry
  182. file thus making life easier for both parties. If there is something
  183. found in the following format that your BBS software may not be currently
  184. supporting, a DEFAULT value has been suggested.
  185.  
  186. ----------
  187. KG, Note:
  188.  
  189.    GAP DOES treat this file as Read/Write since GAP does not use
  190. or have any use for a Door File. GAP will re-read the DOOR.SYS upon
  191. return from a door. But not all fields are re-read. Only those fields
  192. that are marked with an '*' will be read by GAP when a caller returns
  193. from a door.
  194.  
  195.    When reading this file, you should not go into an EOF loop. In
  196. other words, you should not read until you encounter End Of File.
  197. Instead, you should read what you KNOW is there. This allows for
  198. additions to the end of the file without forcing all programs to be
  199. re-compiled.
  200.  
  201. ----------
  202. Note from Jim Harrer:
  203.  
  204.    Beginning with WILDCAT! release 3, we will begin supporting this DOOR.SYS
  205. Standard by creating this file in the \WC30\WCWORK\NODEx (x = Node Number)
  206. directory.  We will NOT read this file back in.  If DOORS wish to change
  207. any of the callers variables, then the door author should refer to our
  208. USERINFO.DAT standard.
  209.  
  210.    Mustang Software will not support any future changes to DOOR.SYS.  Other
  211. BBS authors must regard this DOOR.SYS as a "Standard" and not change or
  212. add to it in any way.  DOOR authors can be assured we will not change
  213. DOOR.SYS in the future.  Any changes we need to make will be done to our
  214. USERINFO.DAT standard.
  215.  
  216.    I hope other BBS authors will join us in agreement of not making any
  217. additional changes to DOOR.SYS in the future.
  218.  
  219. ----------
  220. DOOR.SYS
  221. --------
  222. COM1:             <-- Comm Port - COM0: = LOCAL MODE
  223. 2400              <-- Baud Rate - 300 to 38400
  224. 8                 <-- Parity - 7 or 8
  225. 1                 <-- Node Number - 1 to 99                    (Default to 1)
  226. 19200             <-- DTE Rate. Actual BPS rate to use. (kg)
  227. Y                 <-- Screen Display - Y=On  N=Off             (Default to Y)
  228. Y                 <-- Printer Toggle - Y=On  N=Off             (Default to Y)
  229. Y                 <-- Page Bell      - Y=On  N=Off             (Default to Y)
  230. Y                 <-- Caller Alarm   - Y=On  N=Off             (Default to Y)
  231. Rick Greer        <-- User Full Name
  232. Lewisville, Tx.   <-- Calling From
  233. 214 221-7814      <-- Home Phone
  234. 214 221-7814      <-- Work/Data Phone
  235. PASSWORD          <-- Password
  236. 110              *<-- Security Level
  237. 1456              <-- Total Times On
  238. 03/14/88          <-- Last Date Called
  239. 7560              <-- Seconds Remaining THIS call (for those that particular)
  240. 126               <-- Minutes Remaining THIS call
  241. GR                <-- Graphics Mode - GR=Graph, NG=Non-Graph, 7E=7,E Caller
  242. 23                <-- Page Length
  243. Y                 <-- User Mode - Y = Expert, N = Novice
  244. 1,2,3,4,5,6,7     <-- Conferences/Forums Registered In  (ABCDEFG)
  245. 7                 <-- Conference Exited To DOOR From    (G)
  246. 01/01/99          <-- User Expiration Date              (mm/dd/yy)
  247. 1                 <-- User File's Record Number
  248. Y                 <-- Default Protocol - X, C, Y, G, I, N, Etc.
  249. 0                *<-- Total Uploads
  250. 0                *<-- Total Downloads
  251. 0                *<-- Daily Download "K" Total
  252. 999999            <-- Daily Download Max. "K" Limit
  253. 10/22/88          <-- Caller's Birthdate                              (kg)
  254. G:\GAP\MAIN       <-- Path to the MAIN directory (where User File is) (kg)
  255. G:\GAP\GEN        <-- Path to the GEN directory                       (kg)
  256. Michael           <-- Sysop's Name (name BBS refers to Sysop as)      (kg)
  257. Stud              <-- Alias name                                      (rc)
  258. 00:05             <-- Event time                        (hh:mm)       (rc)
  259. Y                 <-- If its an error correcting connection (Y/N)     (rc)
  260. N                 <-- ANSI supported & caller using NG mode (Y/N)     (rc)
  261. Y                 <-- Use Record Locking                    (Y/N)     (rc)
  262. 14                <-- BBS Default Color (Standard IBM color code, ie, 1-15) (rc)
  263. 10               *<-- Time Credits In Minutes (positive/negative)     (rc)
  264. 07/07/90          <-- Last New Files Scan Date          (mm/dd/yy)    (rc)
  265. 14:32             <-- Time of This Call                 (hh:mm)       (rc)
  266. 07:30             <-- Time of Last Call                 (hh:mm)       (rc)
  267. 6                 <-- Maximum daily files available                   (rc)
  268. 3                *<-- Files d/led so far today                        (rc)
  269. 23456            *<-- Total "K" Bytes Uploaded                        (rc)
  270. 76329            *<-- Total "K" Bytes Downloaded                      (rc)
  271. A File Sucker     <-- User Comment                                    (rc)
  272. 10                <-- Total Doors Opened                              (rc)
  273. 10283             <-- Total Messages Left                             (rc)
  274.  
  275.  
  276.   *****  Each line is STRAIGHT ASCII TEXT with a CR/LF at the end.  *****
  277.  
  278.   Lines marked with an '*' will be re-read in GAP when a caller
  279.   returns from a door.
  280.  
  281.   Rick Greer, the author of this Universal Specification, is no
  282.   where to be found!
  283.  
  284.  
  285.  
  286.